Documentation building

SNiFF+ comes with a set of tools that allow you to incrementally and iteratively document your source code.
SNiFF+ uses your source code's symbol information to generate documentation frames out of a set of configurable templates. You can then fill out these frames during the process of documenting your source code.
What can I document?
You can document any or all of the symbols in your source code. You can select the types of symbols that you want to document in your Preferences.
Browsing and editing documentation
You can browse and edit documentation using SNiFF+'s Documentation Editor. The Documentation Editor behaves much like a hypertext browser that you can use for navigating between source code and its documentation.
Customizing and creating documentation templates
When you document symbols in your source code, SNiFF+ uses documentation template files to generate documentation frames for each symbol. There is one documentation template file for each type of symbol. You can customize the template files that come with SNiFF+, or you can create new ones.
There are two ways in which you can customize documentation template files:

- by using HTML tags for layout
- by using macros to extract information from SNiFF+'s Symbol Table and comments from your source files

Version-controlling documentation
Documentation files can be version-controlled in the same way as the other files in your software system.
Exporting documentation
You can export your documentation in two different formats: MIF (Maker Interchange Format of FrameMaker TM) and HTML. When you export your documentation as MIF files, you also have the option of creating a book file for the individual MIF files.
For detailed information
For details about documenting your source code in SNiFF+, please refer to Documenting Source Code.